8 months ago
MCP server providing token-efficient access to OpenAPI/Swagger specs via MCP Resources for client-side exploration.
Overview
What is OpenAPI Schema Explorer?
OpenAPI Schema Explorer is a server designed to provide token-efficient access to OpenAPI (v3.0) and Swagger (v2.0) specifications through MCP Resources, allowing clients to explore large API specifications without loading the entire file into memory.
How to use OpenAPI Schema Explorer?
To use the OpenAPI Schema Explorer, configure your MCP client (like Claude Desktop) to run the server using methods such as npx, Docker, or local installation. You can specify the path or URL of the OpenAPI specification you want to explore.
Key features of OpenAPI Schema Explorer?
- Token-efficient access to OpenAPI specs via MCP Resources.
- Supports both OpenAPI v3.0 and Swagger v2.0, with automatic conversion.
- Allows loading specifications from local files or remote URLs.
- Provides multiple output formats (JSON, YAML, minified JSON).
- Dynamic server name based on the loaded spec's title.
Use cases of OpenAPI Schema Explorer?
- Exploring API paths and operations without loading entire specifications.
- Facilitating API documentation and testing for developers.
- Integrating with MCP clients for enhanced API interaction.
FAQ from OpenAPI Schema Explorer?
- Can I use OpenAPI Schema Explorer with any MCP client?
Yes! It is designed to work with various MCP clients like Claude Desktop and Cline.
- Is there a need for separate installation?
No, the recommended usage methods (
npxand Docker) do not require separate installation steps.
- What formats can I get the output in?
You can receive output in JSON, YAML, or minified JSON formats.
Server Config
{
"mcpServers": {
"My API Spec (npx)": {
"command": "npx",
"args": [
"-y",
"mcp-openapi-schema-explorer@latest",
"https://petstore3.swagger.io/api/v3/openapi.json",
"--output-format",
"yaml"
],
"env": {}
}
}
}